<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: BimViewer</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: BimViewer</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>BimViewer<span class="signature">(containerDiv, options)</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    
    <h4 class="name" id="BimViewer"><span class="type-signature"></span>new BimViewer<span class="signature">(containerDiv, options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建BimViewer
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>containerDiv</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Div容器</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            
                <td class="default">
                
                    null
                
                </td>
            

            <td class="description last">初始化参数</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>



















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>参数定义如下:{    id: String/Number BimViewer对象id，唯一性,默认采用时间戳,这意味着一个web应用中可以存在多个BimViewer对象，多个对象统一使用ViewerHelper管理    showGrid:是否显示辅助地平网格。默认false    fps:是否显示FPS。默认false    debug:是否控制台输出render debug日志 默认false    loading:使用自带的加载进度控件LoadingMultiplePlugin，支持多模型加载。默认true    streamRender:流式渲染，默认true    loadProperty:是否需要加载构件数据数据 默认true    loadTree:是否需要加载目录树 默认true    loadRoom:是否需要加载房间数据 默认true    localCache:是否启用本地缓存 默认false    navCube:是否默认加载方向插件NavCubePlugin 默认true    farLimit:是否限制相机的远视角距离(camera.far),默认 false     alwaysRefresh:是否开启自动每帧刷新，默认false}</code></pre>



    
    </div>

    

    

    

    

    

    

    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="addPlugin"><span class="type-signature"></span>addPlugin<span class="signature">(plugin)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    添加插件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>plugin</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">引擎提供的各个Plugin</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="changePickMaterial"><span class="type-signature"></span>changePickMaterial<span class="signature">(color, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置pick和框选后构件的颜色和透明度
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearEvent"><span class="type-signature"></span>clearEvent<span class="signature">(eventName)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清除某类事件回调
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>eventName</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearFog"><span class="type-signature"></span>clearFog<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清除雾气
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearLocalCache"><span class="type-signature"></span>clearLocalCache<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清理浏览器中关于BIM模型数据的本地缓存
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearRooms"><span class="type-signature"></span>clearRooms<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    在场景中清除房间
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearZoomToHightlight"><span class="type-signature"></span>clearZoomToHightlight<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清除ZoomTo高亮构件状态，如果有的话
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="coordScreenToWorld"><span class="type-signature"></span>coordScreenToWorld<span class="signature">(screenVector)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    屏幕坐标转世界坐标,返回THREE.Vector3对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>screenVector</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">类似这样的屏幕坐标对象:{x:231,y:45}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="coordWorldToScreen"><span class="type-signature"></span>coordWorldToScreen<span class="signature">(worldVector)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    世界坐标转屏幕坐标
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>worldVector</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Vector3</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createBasicTextureMaterial"><span class="type-signature"></span>createBasicTextureMaterial<span class="signature">(imagePath, deptTest)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    生成一个包含贴图的Basic材质，该材质不受光照的影响
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>imagePath</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">图片url</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>deptTest</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">深度探测，默认是true</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Promise对象
</div>



    





        
            

    

    
    <h4 class="name" id="createDecal"><span class="type-signature"></span>createDecal<span class="signature">(options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    在场景中添加一个贴花
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{     id: 对象标识，Number或String,默认采用时间戳     url: 图片地址url     side: 材质是单面还是双面，默认是单面，如果需要双面，赋值'double'     position：贴花中心点位置，BIMI.THREE.Vector3类型，默认new BIMI.THREE.Vector3(0,0,0)     width:贴花宽度，如果不设置，自动采用图片的宽度作为贴花宽度     height:贴花高度，如果不设置，自动采用图片的高度作为贴花高度     rotate: 贴花旋转偏移量，BIMI.THREE.Vector3类型，默认new BIMI.THREE.Vector3(0,0,0)}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Promise ,返回贴花的mesh对象
</div>



    





        
            

    

    
    <h4 class="name" id="createDom"><span class="type-signature"></span>createDom<span class="signature">(domStr)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    将html文本转为dom对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>domStr</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createGradientMaterial"><span class="type-signature"></span>createGradientMaterial<span class="signature">(modelId, productId, color1, color2, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    针对某个构件，创建符合该构件高度的渐变材质对象,返回材质对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID, String/Number</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件ID,Number</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color1</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">颜色1, String</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color2</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">颜色2, String</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">透明度, Number</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createLambertMaterial"><span class="type-signature"></span>createLambertMaterial<span class="signature">(color, opacity, deptTest)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建Lambert材质(已过时)，建议采用createPBRMaterial替代该函数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度,默认1.0</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>deptTest</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">深度测试，默认true</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createLine"><span class="type-signature"></span>createLine<span class="signature">(points, color, depthTest)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    创建Three的Line，线宽受限webgl永远是1
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0,y:0,z:0},...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>depthTest</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否需要深度探测</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="createPBRMaterial"><span class="type-signature"></span>createPBRMaterial<span class="signature">(type, color, opacity, deptTest)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建PBR材质
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">类型，如果设置为null就是哑光无反射的Lambert材质，type定义目前支持"metal"(金属),"wallpaint"(墙漆),"plasticvinyl"(塑料),"glazing"(玻璃),"concrete"(混凝土),"hardwood"(木材),"ceramic"(陶瓷)</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度，默认1.0</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>deptTest</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">深度测试，默认true</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    材质对象
</div>



    





        
            

    

    
    <h4 class="name" id="createPoints"><span class="type-signature"></span>createPoints<span class="signature">(points, color, pointPixel)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    创建包含一组坐标的Points对象，但不自动绘制
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0,y:0,z:0},...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointPixel</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">点的像素大小</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="disabelProductsReceiveShadow"><span class="type-signature"></span>disabelProductsReceiveShadow<span class="signature">(modelId, productIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置某些构件不接受阴影
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="dispose"><span class="type-signature"></span>dispose<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    引擎销毁释放资源
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="disposeProductsEdge"><span class="type-signature"></span>disposeProductsEdge<span class="signature">(modelId, productIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    取消指定构件Edge
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="drawAnchorMark"><span class="type-signature"></span>drawAnchorMark<span class="signature">(position, color)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    绘制锚点标记(类似百度地图的锚点标记)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">{x:0,y:0,z:0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色 默认 '#00ff00'</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="drawCurve"><span class="type-signature"></span>drawCurve<span class="signature">(points, color)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    通过一系列的Vector3生成圆滑曲线
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="drawLine"><span class="type-signature"></span>drawLine<span class="signature">(points, color)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    使用Three的Line绘制，线宽受限webgl永远是1
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0,y:0,z:0},...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="drawLine2"><span class="type-signature"></span>drawLine2<span class="signature">(points, color, linePixel, dash)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    绘制Line2,参见webgl_lines_fat.html
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0,y:0,z:0},...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>linePixel</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">线宽像素大小，默认5</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dash</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">是否虚线，默认false</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="drawPoints"><span class="type-signature"></span>drawPoints<span class="signature">(points, color, pointPixel)</span><span class="type-signature"> &rarr; {object}</span></h4>
    

    



<div class="description">
    绘制一组Point,点的大小不随相机深度而衰减
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0,y:0,z:0},...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pointPixel</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">点的像素大小</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    shape对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="enableDamping"><span class="type-signature"></span>enableDamping<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Orbit控件是否启用阻尼效果，默认false.dampingFactor是阻尼系数，默认0.05。值越小阻尼越明显
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getCameraState"><span class="type-signature"></span>getCameraState<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获取当前相机的位置和四元数
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getCameraStateForGeo"><span class="type-signature"></span>getCameraStateForGeo<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    当前相机状态数据对应的经纬度、高程、俯仰角数据
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    object，相机的经纬度、高程、俯仰角数据
</div>



    




    <h5>Example</h5>
    
    <pre class="prettyprint"><code>数据格式定义{     camera_pitch: pitch角     camera_yaw: yaw角     camera_latitude: 纬度     camera_longitude: 经度     camera_height: 高度}</code></pre>



        
            

    

    
    <h4 class="name" id="getCamerFrustum"><span class="type-signature"></span>getCamerFrustum<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得当前camera的视锥对象
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getMeterPrePixel"><span class="type-signature"></span>getMeterPrePixel<span class="signature">(position)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    计算某个位置的屏幕像素和世界单位的比例
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Vector3</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getModelBox"><span class="type-signature"></span>getModelBox<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得模型的bbox,注意该API必须在加载模型完成之后调用才会生效
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getModelGroup"><span class="type-signature"></span>getModelGroup<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得模型的Group对象，这是一个模型根节点对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getModels"><span class="type-signature"></span>getModels<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    场景中所有模型对象
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getOrbitMaxDistance"><span class="type-signature"></span>getOrbitMaxDistance<span class="signature">(distance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得Orbit控件的最大限制距离
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>distance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getOrbitState"><span class="type-signature"></span>getOrbitState<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得当前OrbitControl的状态数据
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getPickPorductIds"><span class="type-signature"></span>getPickPorductIds<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得当前场景中pick的构件id
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Map对象，key是modelId，value是Array(productIds)
</div>



    





        
            

    

    
    <h4 class="name" id="getPlugin"><span class="type-signature"></span>getPlugin<span class="signature">(pluginName)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据插件名称查找插件，插件名称是类名
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pluginName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getProduct"><span class="type-signature"></span>getProduct<span class="signature">(modelId, productId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    查找构件对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">构件id</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getProductBbox"><span class="type-signature"></span>getProductBbox<span class="signature">(modelId, productId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    求构件的包围盒
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">构件id</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getProductIdsByModel"><span class="type-signature"></span>getProductIdsByModel<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得模型包含的所有构件ID，返回构件ID数组(Array)，如果该模型ID没有找到对应的Model对象，那么返回null
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    构件ID数组，Array,如果modelId没有查询到对应的模型，返回null
</div>



    





        
            

    

    
    <h4 class="name" id="getProductIdsByType"><span class="type-signature"></span>getProductIdsByType<span class="signature">(types)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据构件类型查询场景中符合条件的构件ID，返回数据结构定义为:[{modelId:XXX,productIds:[XXX,XXX]},...]
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件类型数组 Array</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getProductsByModel"><span class="type-signature"></span>getProductsByModel<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得模型包含的所有构件对象，返回构件数组(Array)，如果该模型ID没有找到对应的Model对象，那么返回null
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    构件数组，Array,如果modelId没有查询到对应的模型，返回null
</div>



    





        
            

    

    
    <h4 class="name" id="getRayPoint"><span class="type-signature"></span>getRayPoint<span class="signature">(event, fliter)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    鼠标射线交点
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">鼠标事件</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fliter</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="THREE.Object3D.html">THREE.Object3D</a></span>


            
            </td>

            

            

            <td class="description last">过滤根节点</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getRoomIntersectsProducts"><span class="type-signature"></span>getRoomIntersectsProducts<span class="signature">(modelId, roomId, onlyContains, roomExpand)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得与Room空间相交(包含)的构件,目前是基于Box3判断相交的，如果Room几何是异形几何会不准确，后续版本修正
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>roomId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onlyContains</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">是否只求包含的构件，默认false(即相交和包含逻辑都要)</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>roomExpand</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">onlyContains为true时，扩展Room空间的尺寸，这是为了将一些建模时正好和Room相交的构件也纳入包含逻辑中，默认值0.01</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hasFilterColor"><span class="type-signature"></span>hasFilterColor<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获得场景中是否包含过滤器着色数据
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hdr"><span class="type-signature"></span>hdr<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    HDR效果渲染,采用ACES算法
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hdrExposure"><span class="type-signature"></span>hdrExposure<span class="signature">(exposure)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    HDR曝光度，默认值是1
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>exposure</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="isBimModel"><span class="type-signature"></span>isBimModel<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    判断模型是否是BIM模型对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="isDirty"><span class="type-signature"></span>isDirty<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    刷新场景
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="isolateProducts"><span class="type-signature"></span>isolateProducts<span class="signature">(isolateMap)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    隔离构件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>isolateMap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Map</span>


            
            </td>

            

            

            <td class="description last">Map的结构{modelId:[productId]},如果传入空Map或者null，那么就取消隔离</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(url, options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    加载BIM、gltf、glb、fbx、obj模型的统一接口,返回Promise对象，该Prosmise对象提供event参数用于读取模型的一些重要属性
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">bim模型url</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">加载参数，对象类型</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>



















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>viewer.load(xxxxxx/bim.bin',{modelId:'myModel1'}).then((event)=>{     console.info(event)  }); options数据定义如下:{                                                                name:模型名称，在loading上会以该名称显示       modelId:可指定模型ID，否则引擎自动递增作为默认模型ID,建议指定ID，ID可以是文本或整数类型      updateRegion:是否需要重置相机视角，默认为true,如果启用地图模式(使用MapPlugin),可以设置为false，这样加载模型后不会改动相机位置和视角      location: 模型位置，默认BIMI.THREE.Vector3(0,0,0)      latitude: 模型位置纬度坐标，默认null，该值和location互斥，当设置经纬度后，引擎会自动将经纬度坐标转为世界坐标并替代location      longitude：模型位置经度坐标，默认null，该值和location互斥，当设置经纬度后，引擎会自动将经纬度坐标转为世界坐标并替代location      offset: 位置偏移量，默认BIMI.THREE.Vector3(0,0,0)      scale: 模型缩放量，默认BIMI.THREE.Vector3(1,1,1)      rotate: 模型旋转量，默认BIMI.THREE.Vector3(0,0,0)      toZero: 模型中心基准点是否落在location(或latitude、longitude)上，默认true。     }</code></pre>



        
            

    

    
    <h4 class="name" id="loadMerge"><span class="type-signature"></span>loadMerge<span class="signature">(models)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    合模加载操作，常用于对建模时同属一个坐标系的多个分解模型文件进行合模加载，注意:这不是多个模型同时加载，而是合模加载操作，使用前请先理解BIM中合模的概念。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型组参数对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Promise，确保所有模型加载完毕后的回调，但该回调then没有参数
</div>



    




    <h5>Example</h5>
    
    <pre class="prettyprint"><code>模型组参数对象举例：//对两个模型进行合模，第一个是主模型，第二个是从模型，位置、缩放、旋转、偏移等加载参数都在主模型参数中设置，从模型统一自动采用主模型的参数，数以，从模型只要设置modelId和name viewer.loadMerge(          [              {                  url:'temp/柱1/bim.bin',options:{modelId:'myMaster',name:'主模型',location:new THREE.Vector3(0,10,0),scale:new THREE.Vector3(10,10,10)}              },              {                  url:'temp/柱23/bim.bin',options:{modelId:'mySlave1',name:'从模型1'}              },          ]      ).then(()=>{          console.info('模型组合加载完毕')      })</code></pre>



        
            

    

    
    <h4 class="name" id="lockAxis"><span class="type-signature"></span>lockAxis<span class="signature">(direction, min, max)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    锁定相机旋转位置
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>direction</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">'horizontal'水平方向旋转角度范围，即左右旋转。如果设置，则间隔[min，max]必须是[-2 PI，2 PI]的子间隔，且（max-min <2 PI）<br/>'vertical'  垂直方向旋转角度范围，即上下旋转。如果设置，则间隔[min，max]必须是[0 ， Math.PI]的子间隔</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>min</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>max</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="lookAt"><span class="type-signature"></span>lookAt<span class="signature">(x, y, z)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置相机的焦点坐标
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>z</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="moveProducts"><span class="type-signature"></span>moveProducts<span class="signature">(modelId, productIds, moveVec3, time)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    移动构件，可以处理Z-Fighting导致的构件闪烁问题
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件ID数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>moveVec3</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last">移动量</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>time</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">移动时间，默认0</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="off"><span class="type-signature"></span>off<span class="signature">(eventName, callback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    取消事件回调
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>eventName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">事件名称</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">回调</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="on"><span class="type-signature"></span>on<span class="signature">(eventName, callback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    注册回调事件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>eventName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">事件名称</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">回调</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="onlySeeProducts"><span class="type-signature"></span>onlySeeProducts<span class="signature">(productMap)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    只可见以下构件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>productMap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Map</span>


            
            </td>

            

            

            <td class="description last">Map的结构{modelId:[productId]}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="onlySeeProductsByLevels"><span class="type-signature"></span>onlySeeProductsByLevels<span class="signature">(modelId, levelNames)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    只可见指定层高的构件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelNames</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">层高名称数组</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="overrideProductsColor"><span class="type-signature"></span>overrideProductsColor<span class="signature">(modelId, productIds, color, opacity, phong)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件自定义材质(替换原始材质，即永久材质)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件id数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>phong</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否高亮</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="overrideProductsColorByType"><span class="type-signature"></span>overrideProductsColorByType<span class="signature">(}, color, opacity, phong)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据构件type批量设置构件自定义材质(替换原始材质，即永久材质)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>}</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">types 类型数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>phong</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否高亮</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="overrideProductsMaterial"><span class="type-signature"></span>overrideProductsMaterial<span class="signature">(modelId, productIds, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件自定义材质(替换原始材质，即永久材质)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件id数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Material</span>


            
            </td>

            

            

            <td class="description last">材质</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="overrideProductsMaterialByType"><span class="type-signature"></span>overrideProductsMaterialByType<span class="signature">(types, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    按照类型，设置构件自定义材质(替换原始材质，即永久材质)考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件类型数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">材质</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="overrideProductsOpacity"><span class="type-signature"></span>overrideProductsOpacity<span class="signature">(modelId, productIds, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件透明度,不改变原始材质
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件id数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="printScreen"><span class="type-signature"></span>printScreen<span class="signature">(callback, scale)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    对BIM模型、批注、数据标签等屏幕截图(速度较慢)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">回调函数，参数是Image</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>scale</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">图片缩放比率，默认为null，即按照设备屏幕比率自动生成</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeMesh"><span class="type-signature"></span>removeMesh<span class="signature">(mesh)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    从场景中删除一个mesh对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>mesh</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">需要删除的mesh对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removePlugin"><span class="type-signature"></span>removePlugin<span class="signature">(plugin)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    移除插件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>plugin</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">插件对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removePluginByName"><span class="type-signature"></span>removePluginByName<span class="signature">(pluginName)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    移除插件，根据插件名称
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pluginName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">插件名称</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeShape"><span class="type-signature"></span>removeShape<span class="signature">(shape)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    移除创建的shape
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>shape</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">生成的shape对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resetFilterColor"><span class="type-signature"></span>resetFilterColor<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Revit模型真实渲染模式下，取消过滤器着色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resetHomeState"><span class="type-signature"></span>resetHomeState<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    控制相机回归到Home视角
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resetPick"><span class="type-signature"></span>resetPick<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    恢复当前被Pick的构件的高亮状态
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resetProductsMaterial"><span class="type-signature"></span>resetProductsMaterial<span class="signature">(modelId, productId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    恢复构件原始材质，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">构件ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resetProductsMaterialByType"><span class="type-signature"></span>resetProductsMaterialByType<span class="signature">(types, material, merge)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    按构件类型reset材质
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件类型</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Material</span>


            
            </td>

            

            

            <td class="description last">材质</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>merge</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否恢复合并 默认true</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="screenImage"><span class="type-signature"></span>screenImage<span class="signature">(callback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    只对BIM模型截屏
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">回调参数是Image对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="screenSpacePanning"><span class="type-signature"></span>screenSpacePanning<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Orbit控件移动操作(Pan)时，当上下移动时，是否考虑高度移动。默认false
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setBoxShadow"><span class="type-signature"></span>setBoxShadow<span class="signature">(}, options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    场景边缘阴影渐变效果.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>}</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">enable 是否启用，默认true，如果设置为false，则是关闭该效果</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">边框阴影参数定义</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>



















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>参数定义{     color:背景色，默认值 '#353535'     shadow:阴影色,默认值'#353535'     blur:模糊距离,默认值'300px'     spread:阴影的大小,默认值'200px'}</code></pre>



        
            

    

    
    <h4 class="name" id="setConfig"><span class="type-signature"></span>setConfig<span class="signature">(url)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    加载设置
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">设置文件url</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setDefaultOrbitState"><span class="type-signature"></span>setDefaultOrbitState<span class="signature">(state)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置相机初始化默认位置和旋转角度数据，要在load之前调用才生效
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>state</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">通过调用getOrbitState获得的数据对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setFilterColor"><span class="type-signature"></span>setFilterColor<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Revit模型真实渲染模式下，设置过滤器着色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setFog"><span class="type-signature"></span>setFog<span class="signature">(density)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置指数雾，它可以在相机附近提供清晰的视野，且距离相机越远，雾的浓度随着指数增长越快。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>density</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">指数默认值0.0025</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setMinZoomIn"><span class="type-signature"></span>setMinZoomIn<span class="signature">(scale)</span><span class="type-signature"></span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>scale</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">设置最小放大比例(默认值是1)，针对特别小的模型建议设置值为0.001</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setModelMaterial"><span class="type-signature"></span>setModelMaterial<span class="signature">(modelId, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    对整个模型设置一个材质
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">材质对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setModelPosition"><span class="type-signature"></span>setModelPosition<span class="signature">(modelId, options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型位置(包括偏移、缩放、旋转、基点调节)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">参数对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>



















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>参数对象举例:{     location: 模型位置，默认BIMI.THREE.Vector3(0,0,0)      latitude: 模型位置纬度坐标，默认null，该值和location互斥，当设置经纬度后，引擎会自动将经纬度坐标转为世界坐标并替代location      longitude：模型位置经度坐标，默认null，该值和location互斥，当设置经纬度后，引擎会自动将经纬度坐标转为世界坐标并替代location      offset: 位置偏移量，默认BIMI.THREE.Vector3(0,0,0)      scale: 模型缩放量，默认BIMI.THREE.Vector3(1,1,1)      rotate: 模型旋转量，默认BIMI.THREE.Vector3(0,0,0)      toZero: 模型中心基准点是否落在location(或latitude、longitude)上，默认true。     masterModelId：主模型ID，该参数只有在需要做BIM合模操作下才考虑，默认null。}</code></pre>



        
            

    

    
    <h4 class="name" id="setModelVisible"><span class="type-signature"></span>setModelVisible<span class="signature">(modelId, visible)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型可见性
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>visible</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否可见，默认true</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setNormalModel"><span class="type-signature"></span>setNormalModel<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型正常模式展示
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOrbitMaxDistance"><span class="type-signature"></span>setOrbitMaxDistance<span class="signature">(distance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置Orbit控件的最大限制距离
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>distance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">最大距离</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOrbitState"><span class="type-signature"></span>setOrbitState<span class="signature">(json, fly, duration, callback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置OrbitControl的状态
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>json</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">状态数据对象</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fly</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">是否需要飞行动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">动画时长 毫秒</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">飞行结束回调</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setPickedProducts"><span class="type-signature"></span>setPickedProducts<span class="signature">(modelId, productIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    通过代码，设置当前picked的构件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件ID数组 (Array)</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsEdge"><span class="type-signature"></span>setProductsEdge<span class="signature">(modelId, productId, productVisible)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置指定构件增加Edge模式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">构件ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productVisible</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">构件本身是否可见 默认false</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsMaterial"><span class="type-signature"></span>setProductsMaterial<span class="signature">(modelId, productIds, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件自定义材质(临时材质,可以reset恢复)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件ID数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Material</span>


            
            </td>

            

            

            <td class="description last">材质对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsMaterialByType"><span class="type-signature"></span>setProductsMaterialByType<span class="signature">(types, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    按构件类型设置构件自定义材质(临时材质,可以reset恢复)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件类型数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">材质</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsMaterialColor"><span class="type-signature"></span>setProductsMaterialColor<span class="signature">(modelId, productIds, color, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    只修改构件材质的颜色，保留当前材质的贴图和属性(临时材质,可以reset恢复)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件ID数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">不透明度，null表示不变动，默认值是null</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsMaterialOpacity"><span class="type-signature"></span>setProductsMaterialOpacity<span class="signature">(modelId, productIds, color, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    只修改构件材质的透明度，保留当前材质的颜色、贴图和属性(临时材质,可以reset恢复)，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件ID数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">不透明度，null表示不变动，默认值是null</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsTransparent"><span class="type-signature"></span>setProductsTransparent<span class="signature">(modelId, productIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件透明，透明样式采用BimViewer的_transparentMaterial属性定义，用户可修改该属性
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsVisible"><span class="type-signature"></span>setProductsVisible<span class="signature">(modelId, productIds, visible)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置构件可见性，考虑到性能，在批量设置之后，需要手动调用isDirty()
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件id数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>visible</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">可见性</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setProductsVisibleByType"><span class="type-signature"></span>setProductsVisibleByType<span class="signature">(types, visible)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据构件类别设置可见性
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">构件类型数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>visible</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">可见性</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setReplaceStyle"><span class="type-signature"></span>setReplaceStyle<span class="signature">(data)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    替换构件原始材质，在load之前调用该函数，可以实现在渐进性加载过程中使用指定的替换材质效果
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">指定样式，参数类型Object,样式可byModel、byType、byProduct自由组合。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>



















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>参数举例: {
            //根据模型设置,指定modelId的模型整体都采用style样式 
            byModel:[ 
                { 
                    modelId:1, 
                    //style的属性包含颜色、不透明度、材质类型三个定义，其中颜色和材质类型是可选参数，其组合说明如下：
                    //不设置color,那么就针对构件的原始材质做透明化处理，该功能只对byModel起效 
                    //不设置type，那么为默认亚光材质，type目前支持"metal"(金属),"wallpaint"(墙漆),"plasticvinyl"(塑料),"glazing"(玻璃),"concrete"(混凝土),"hardwood"(木材),"ceramic"(陶瓷)
                    style:{color:'#ffffff',opacity:1.0,type:'metal'}
                },
                ......
            ], 
            //根据构件类型设置,场景中所有构件的类型符合指定类型，都采用style样式
            byType:[ 
                { 
                    types:['IfcBuildingElementProxy'], 
                    style:{color:'#0b4161',opacity:0.2}  
                }, 
                { 
                    types:['IfcRoof','IfcBeam','IfcColumn','IfcWallStandardCase','IfcWindow','IfcSlab','IfcDoor'],
                    style:{color:'#0f628c', opacity:0.5} 
                }, 
                ......
            ],
            //根据构件ID设置，场景中的所有构件的构造ID符合指定构件ID，都采用style样式
            byProduct:[ 
                { 
                    modelId:1, 
                    productIds:[1165376,921443,921468,921393,921418], 
                    style:{color:'#341132',opacity:1} 
                }, 
                ......
            ]  } </code></pre>



        
            

    

    
    <h4 class="name" id="setRoomVisible"><span class="type-signature"></span>setRoomVisible<span class="signature">(modelId, roomId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置Room Mesh可见性，Room定义需要rvt建模支持，如果rvt具备Room数据，那么到处空间结构数据的时候，会生成room.json文件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>roomId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">room ID</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneBackground"><span class="type-signature"></span>setSceneBackground<span class="signature">(background)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    若不为null，在渲染场景的时候将设置背景，且背景总是首先被渲染的。 可以设置String/Three.Color（颜色）一个覆盖canvas的Texture（纹理）或是CubeTexture。默认值为null。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>background</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">场景背景色，如果不设置，那么场景背景透明，可设置颜色、纹理。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setTransparentModel"><span class="type-signature"></span>setTransparentModel<span class="signature">(modelId, color, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型半透明展示
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">颜色，可选参数,默认为#ffffff</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度，可选参数,默认为0.3</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setTransparentModelSaveOriginalMaterial"><span class="type-signature"></span>setTransparentModelSaveOriginalMaterial<span class="signature">(modelId, opacity)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型半透明展示(保持原始材质的样式)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">不透明度，默认0.5</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="unload"><span class="type-signature"></span>unload<span class="signature">(modelId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    从场景中移除模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="worldToRevit"><span class="type-signature"></span>worldToRevit<span class="signature">(worldVector)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    世界坐标转模型原始坐标(如果是revit，注意revit是Z朝上)(返回数据的单位是米，注意revit的单位可能是英尺，需要自行从米转换到英尺)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>worldVector</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Vector3</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Vector3,模型原始坐标
</div>



    





        
            

    

    
    <h4 class="name" id="zoomToBox"><span class="type-signature"></span>zoomToBox<span class="signature">(box, fitOffset, fly, callback, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦定位包围盒
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>box</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Box3</span>


            
            </td>

            

            

            <td class="description last">包围盒</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fitOffset</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">和距离有关 默认1.2 建议不要改动</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fly</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否飞行动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">飞行结束后的回调</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">飞行时间，默认1500毫秒</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToModel"><span class="type-signature"></span>zoomToModel<span class="signature">(modelId, fitOffset, fly, callback, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number/String</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fitOffset</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">和距离有关 默认1.2 建议不要改动</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fly</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否飞行动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">飞行结束后的回调</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">飞行时间，默认1500毫秒</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToProduct"><span class="type-signature"></span>zoomToProduct<span class="signature">(modelId, productId, fly, callback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦构件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fly</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">是否飞行动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">飞行结束回调</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToProductAndHightlight"><span class="type-signature"></span>zoomToProductAndHightlight<span class="signature">(modelId, productId, zoomMaterial)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦构件并且高亮,该高亮状态会在下一个zoomToProductAndHightlight后清除，也可以手动调用clearZoomToHightlight()清除当前的高亮状态
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件ID</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoomMaterial</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">高亮材质，可以创建一个可复用的材质对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToProductAndPick"><span class="type-signature"></span>zoomToProductAndPick<span class="signature">(modelId, productId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦构件并且Pick状态
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToProductAndPosition"><span class="type-signature"></span>zoomToProductAndPosition<span class="signature">(position, modelId, productId, time)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    飞行到某个位置,中心点设置为某个构件bbox中心
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">相机的最终位置</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">模型id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">构件id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>time</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">飞行时长 毫秒 默认1500</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToProducts"><span class="type-signature"></span>zoomToProducts<span class="signature">(modelId, productIds, fly)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦多个构件的bbox
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>productIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fly</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="zoomToRoom"><span class="type-signature"></span>zoomToRoom<span class="signature">(modelId, roomId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    聚焦定位至房间
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>roomId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnnotationPlugin.html">AnnotationPlugin</a></li><li><a href="BillboardPlugin.html">BillboardPlugin</a></li><li><a href="BimViewer.html">BimViewer</a></li><li><a href="CircleWaveMeshPlugin.html">CircleWaveMeshPlugin</a></li><li><a href="CircleWavePlugin.html">CircleWavePlugin</a></li><li><a href="ClipBoxPlugin.html">ClipBoxPlugin</a></li><li><a href="ClipPlugin.html">ClipPlugin</a></li><li><a href="CommonTools.html">CommonTools</a></li><li><a href="CustomModel.html">CustomModel</a></li><li><a href="EdgePlugin.html">EdgePlugin</a></li><li><a href="ExplodePlugin.html">ExplodePlugin</a></li><li><a href="FencePlugin.html">FencePlugin</a></li><li><a href="FireClotPlugin.html">FireClotPlugin</a></li><li><a href="FirePlanPlugin.html">FirePlanPlugin</a></li><li><a href="FirePlugin.html">FirePlugin</a></li><li><a href="FlashPlugin.html">FlashPlugin</a></li><li><a href="FlyPlugin.html">FlyPlugin</a></li><li><a href="FpsPlugin.html">FpsPlugin</a></li><li><a href="GroundPlugin.html">GroundPlugin</a></li><li><a href="HeatmapCanvas.html">HeatmapCanvas</a></li><li><a href="HeatmapGridPlugin.html">HeatmapGridPlugin</a></li><li><a href="HeatmapPlugin.html">HeatmapPlugin</a></li><li><a href="HlsPlugin.html">HlsPlugin</a></li><li><a href="HtmlAnchorPlugin.html">HtmlAnchorPlugin</a></li><li><a href="HtmlDomPlugin.html">HtmlDomPlugin</a></li><li><a href="HtmlIconLabelPlugin.html">HtmlIconLabelPlugin</a></li><li><a href="HtmlLabelPlugin.html">HtmlLabelPlugin</a></li><li><a href="HtmlMarkerPlugin.html">HtmlMarkerPlugin</a></li><li><a href="ManPlugin.html">ManPlugin</a></li><li><a href="MapNode.html">MapNode</a></li><li><a href="MapPlugin.html">MapPlugin</a></li><li><a href="MapTools.html">MapTools</a></li><li><a href="MathHelp.html">MathHelp</a></li><li><a href="MeasurePlugin.html">MeasurePlugin</a></li><li><a href="module.exports_module.exports.html">exports</a></li><li><a href="MouseCapturePlugin.html">MouseCapturePlugin</a></li><li><a href="NavigationMapPlugin.html">NavigationMapPlugin</a></li><li><a href="OSGBPlugin.html">OSGBPlugin</a></li><li><a href="OutlinePlugin.html">OutlinePlugin</a></li><li><a href="PathRoamingPlugin.html">PathRoamingPlugin</a></li><li><a href="RainMaskPlugin.html">RainMaskPlugin</a></li><li><a href="RoadGeometryUtil.html">RoadGeometryUtil</a></li><li><a href="RoadPlugin.html">RoadPlugin</a></li><li><a href="RotatePlugin.html">RotatePlugin</a></li><li><a href="RotateScenePlugin.html">RotateScenePlugin</a></li><li><a href="SelectionBoxPlugin.html">SelectionBoxPlugin</a></li><li><a href="ShadowPlugin.html">ShadowPlugin</a></li><li><a href="SkyBoxPlugin.html">SkyBoxPlugin</a></li><li><a href="SmokePlugin.html">SmokePlugin</a></li><li><a href="SnowMaskPlugin.html">SnowMaskPlugin</a></li><li><a href="SpriteDomPlugin.html">SpriteDomPlugin</a></li><li><a href="SpriteLabelPlugin.html">SpriteLabelPlugin</a></li><li><a href="SpritePicturePlugin.html">SpritePicturePlugin</a></li><li><a href="SunPlugin.html">SunPlugin</a></li><li><a href="SvgCloudFrame.html">SvgCloudFrame</a></li><li><a href="SvgCloudLine.html">SvgCloudLine</a></li><li><a href="SvgEllipse.html">SvgEllipse</a></li><li><a href="SvgError.html">SvgError</a></li><li><a href="SvgLineArrow.html">SvgLineArrow</a></li><li><a href="SvgMultiplyLine.html">SvgMultiplyLine</a></li><li><a href="SvgRect.html">SvgRect</a></li><li><a href="SweepLightPlugin.html">SweepLightPlugin</a></li><li><a href="Tile.html">Tile</a></li><li><a href="Tip.html">Tip</a></li><li><a href="Toolbar.html">Toolbar</a></li><li><a href="TranslatePlugin.html">TranslatePlugin</a></li><li><a href="TubeFlowPlugin.html">TubeFlowPlugin</a></li><li><a href="TubeFlowWaterPlugin.html">TubeFlowWaterPlugin</a></li><li><a href="TweenTransparentPlugin.html">TweenTransparentPlugin</a></li><li><a href="UnrealBloomPlugin.html">UnrealBloomPlugin</a></li><li><a href="VideoPlugin.html">VideoPlugin</a></li><li><a href="ViewerEvent.html">ViewerEvent</a></li><li><a href="ViewerHelper.html">ViewerHelper</a></li><li><a href="Water.html">Water</a></li><li><a href="WaterPlugin.html">WaterPlugin</a></li></ul><h3>Global</h3><ul><li><a href="global.html#dispose">dispose</a></li><li><a href="global.html#setAction">setAction</a></li><li><a href="global.html#startAnimation">startAnimation</a></li><li><a href="global.html#stopAnimation">stopAnimation</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Aug 29 2023 16:58:54 GMT+0800 (GMT+08:00)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>